/* Copyright  2009-2010
   @Author
   Richard Changde Yin            e-mail yinchangde@hotmail.com

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

/*
*
*  @filename fields/str.h
**/

#ifndef _SERVER_FIELD_STR_
#define _SERVER_FIELD_STR_

#include <field.h>

typedef struct charset_info_st CHARSET_INFO;

/* base class for all string related classes */

class Field_str :public Field {
protected:
  const CHARSET_INFO *field_charset;
  enum Derivation field_derivation;
public:
  Field_str(unsigned char *ptr_arg,uint32_t len_arg,
            unsigned char *null_ptr_arg,
            unsigned char null_bit_arg, utype unireg_check_arg,
            const char *field_name_arg, const CHARSET_INFO * const charset);

  inline Item_result result_type () const { return STRING_RESULT; }

  /// m_string.h
  inline uint32_t decimals() const { return NOT_FIXED_DEC; }

  using Field::store;
  int  store(double nr);
  int  store(int64_t nr, bool unsigned_val)=0;
  int  store_decimal(const my_decimal *);
  int  store(const char *to,uint32_t length, const CHARSET_INFO * const cs)=0;

  inline uint32_t size_of() const { return sizeof(*this); }
  const CHARSET_INFO *charset(void) const { return field_charset; }
  inline void set_charset(const CHARSET_INFO * const charset_arg)
  { field_charset= charset_arg; }
  enum Derivation derivation(void) const { return field_derivation; }
  inline virtual void set_derivation(enum Derivation derivation_arg)
  { field_derivation= derivation_arg; }
  inline bool binary() const { return field_charset == &my_charset_bin; }
  inline uint32_t max_display_length() { return field_length; }
  ///  field.h
  friend class Create_field;

  db_decimal *val_decimal(db_decimal *);

  inline virtual bool str_needs_quotes() { return true; }

  bool compare_str_field_flags(Create_field *new_field, uint32_t flags);

  uint32_t is_equal(Create_field *new_field);
};  // End of Class Field_str

/*
  Report "not well formed" or "cannot convert" error
  after storing a character string info a field.

  SYNOPSIS
    check_string_copy_error()
    field                    - Field
    well_formed_error_pos    - where not well formed data was first met
    cannot_convert_error_pos - where a not-convertable character was first met
    end                      - end of the string
    cs                       - character set of the string

  NOTES
    As of version 5.0 both cases return the same error:

      "Invalid string value: 'xxx' for column 't' at row 1"

  Future versions will possibly introduce a new error message:

      "Cannot convert character string: 'xxx' for column 't' at row 1"

  RETURN
    false - If errors didn't happen
    true  - If an error happened
*/

bool check_string_copy_error(Field_str *field,
                             const char *well_formed_error_pos,
                             const char *cannot_convert_error_pos,
                             const char *end,
                             const CHARSET_INFO * const cs);


#endif
